// Copyright 2016 Proyectos y Sistemas de Mantenimiento SL (eProsima).
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// ------------------------------------------------------------------
// Modification history:
// feature: Code style modification
// ------------------------------------------------------------------

#ifndef INCLUDE_ERTPS_PUBLISHER_PUBLISHERLISTENER_H_
#define INCLUDE_ERTPS_PUBLISHER_PUBLISHERLISTENER_H_

#include <ertps/rtps/common/MatchingInfo.h>
#include <ertps/qos/DeadlineMissedStatus.h>
#include <ertps/qos/LivelinessLostStatus.h>

namespace evbs {
namespace ertps {

class Publisher;

/**
 * Class PublisherListener, allows the end user to implement callbacks triggered by certain events.
 * @ingroup ERTPS_MODULE
 * @snippet ertpsexample.cpp ex_PublisherListener
 */
class RTPS_DllAPI PublisherListener {
 public:
    PublisherListener() {}

    virtual ~PublisherListener() {}

    /**
     * This method is called when the Publisher is matched (or unmatched) against an endpoint.
     * @param pub Pointer to the associated Publisher
     * @param info Information regarding the matched subscriber
     */
    virtual void onPublicationMatched(Publisher* pub, rtps::MatchingInfo& info) {
        (void)pub;
        (void)info;
    }

    /**
     * A method called when a deadline is missed
     * @param pub Pointer to the associated Publisher
     * @param status The deadline missed status
     */
    virtual void on_offered_deadline_missed(Publisher* pub, const OfferedDeadlineMissedStatus& status) {
        (void)pub;
        (void)status;
    }

    /**
     * @brief Method called when the liveliness of a publisher is lost
     * @param pub The publisher
     * @param status The liveliness lost status
     */
    virtual void on_liveliness_lost(Publisher* pub, const LivelinessLostStatus& status) {
        (void)pub;
        (void)status;
    }
};

}  // namespace ertps
} /* namespace evbs */

#endif  // INCLUDE_ERTPS_PUBLISHER_PUBLISHERLISTENER_H_
